GetWindowIdealUserState

Obtains the size and position of a window in its user state.

pascal OSStatus GetWindowIdealUserState (
WindowPtr window,
Rect *userState);

window

A value of type WindowPtr . Pass a pointer to the window for which you wish to obtain the user state.

userState

A pointer to a structure of type Rect . On return, this rectangle specifies the current size and position of the window's user state, in global coordinates.

function result

A result code. See Result Codes.

DISCUSSION

Because the window definition function relies upon the WStateData structure, it is unaware of the ideal standard state, and this causes the user state data that it stores in the WStateData structure to be unreliable. While the Window Manager is reliably aware of the window's zoom state, it cannot record the current user state in the WStateData structure, because the window definition function can overwrite that data. Therefore, the function ZoomWindowIdeal maintains the window's user state independently of the WStateData structure. The GetWindowIdealUserState function gives your application access to the user state data maintained by ZoomWindowIdeal . However, your application should not typically need to use this function; it is supplied for completeness.

VERSION NOTES

Available with Mac OS 8.5 and later.